/*
 * Copyright (c) 2012 Robert Burrell Donkin robertburrelldonkin.name
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
 * and associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software 
 * is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or 
 * substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING 
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 */
package walrus.text.wiki.micro;

public abstract class AbstractFilter implements WikiPullParser {

	private final WikiPullParser parser;
	private final WikiTracker tracker;

	public AbstractFilter(final WikiPullParser parser) {
		super();
		this.parser = parser;
		this.tracker = new WikiTracker();
	}

	public final void clear() {
		tracker.reset();
		parser.clear();
		doClear();
	}
	

	protected abstract void doClear();

	public WikiState next() {
			final WikiState next = parser.next();
			if (next == WikiState.END) {
				return next;
			}
			tracker.next(next);
			return processNext(tracker, next);
		}

	protected abstract WikiState processNext(final WikiTracker tracker, final WikiState next);
	
	public final CharSequence text() {
		return parser.text();
	}

	@Override
	public String toString() {
		return "parser=" + parser + "";
	}

}